Update README for SQL Connect#35
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request attempts to rename 'Firebase Data Connect' to 'Firebase SQL Connect' throughout the README.md file. The review feedback correctly identifies that this change is inconsistent with the official product branding, the Firebase CLI, and the SDK, which would likely lead to user confusion. All review comments provide actionable suggestions to revert these naming changes to maintain consistency with the existing tooling and documentation.
| @@ -1,26 +1,26 @@ | |||
| Firebase DataConnect Quickstart | |||
| Firebase SQL Connect Quickstart | |||
There was a problem hiding this comment.
The product is officially named Firebase Data Connect. Changing it to Firebase SQL Connect in the documentation is inconsistent with the official branding, the Firebase CLI, and the SDK. This will confuse users who are looking for the service in the Firebase Console or using the CLI.
| Firebase SQL Connect Quickstart | |
| Firebase Data Connect Quickstart |
| 1. Clone this repository to your local machine. | ||
| 2. Initialize your Firebase project with `firebase init dataconnect`. Overwrite only dataconnect.yaml when prompted, do not overwrite any other dataconnect files. | ||
| (Optional): If you intend on using other Firebase features, run `firebase init` instead, and select both DataConnect options as well as any feature you intend to use. | ||
| (Optional): If you intend on using other Firebase features, run `firebase init` instead, and select both SQL Connect options as well as any feature you intend to use. |
There was a problem hiding this comment.
The firebase init command uses the name Data Connect in its interactive menu. Referring to it as SQL Connect here will make it difficult for users to identify the correct option to select.
| (Optional): If you intend on using other Firebase features, run `firebase init` instead, and select both SQL Connect options as well as any feature you intend to use. | |
| (Optional): If you intend on using other Firebase features, run firebase init instead, and select both Data Connect options as well as any feature you intend to use. |
| (Optional): If your Firebase project was not initialized in the last section, you can click `Run firebase init` and select `SQL Connect` to initialize. | ||
| 4. Click on deploy to deploy your schema to your cloud SQL instance. Or run `firebase deploy --only dataconnect` (this will also activate vectors search if it's enabled in the schema). | ||
| 5. Running the VSCode extension should automatically start the DataConnect emulators. If you see an emulators error, try running `firebase emulators:start dataconnect` manually. | ||
| 5. Running the VSCode extension should automatically start the SQL Connect emulators. If you see an emulators error, try running `firebase emulators:start dataconnect` manually. |
There was a problem hiding this comment.
The text refers to SQL Connect emulators, but the command provided in the same sentence uses dataconnect. To avoid confusion and maintain consistency with the CLI, the service should be referred to by its official name, Data Connect.
| 5. Running the VSCode extension should automatically start the SQL Connect emulators. If you see an emulators error, try running `firebase emulators:start dataconnect` manually. | |
| 5. Running the VSCode extension should automatically start the Data Connect emulators. If you see an emulators error, try running firebase emulators:start dataconnect manually. |
1 participant
No description provided.